/*
 * Copyright (c) 2010 Google Inc.
 * 
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not
 * use this file except in compliance with the License. You may obtain a copy of
 * the License at
 * 
 * http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 * License for the specific language governing permissions and limitations under
 * the License.
 */

package com.google.api.data.contacts.v3.model;

import com.google.api.client.util.Key;

/**
 * Describes an ID of the contact in an external system of some kind.
 * 
 * @author Nicolas Garnier
 */
public class ExternalId {

  /** Used to specify that the Contact's externalId is an account number. */
  public static final String TYPE_ACCOUNT = "account";

  /** Used to specify that the Contact's externalId is a Customer ID. */
  public static final String TYPE_CUSTOMER = "customer";

  /** Used to specify that the Contact's externalId is a Network Identifier. */
  public static final String TYPE_NETWORK = "network";

  /**
   * Used to specify that the Contact's externalId is an identifier related to
   * the organization of the Contact.
   */
  public static final String TYPE_ORGANIZATION = "organization";

  /**
   * A programmatic value that identifies the type of external ID. Valid values
   * are {@link #TYPE_ACCOUNT}, {@link #TYPE_CUSTOMER}, {@link #TYPE_NETWORK}
   * and {@link #TYPE_ORGANIZATION}.
   */
  @Key("@rel")
  public String type;

  /** A simple string value used to name this ID. */
  @Key("@label")
  public String label;

  /** The value of this external ID. */
  @Key("@value")
  public String value;
}
